home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / animatin / anim_g2p / pd3dctrl / pd3dctl.doc < prev   
Encoding:
Text File  |  1995-04-26  |  15.9 KB  |  533 lines

  1.  
  2.  
  3.          ****   PD3DCTL IS PUBLIC DOMAIN AND NOT FOR SALE  ****
  4.  
  5.  
  6.  
  7.                                 Antic presents
  8.                      PD3DCTL.ACC Motion-Control Accessory
  9.                             For use with CAD-3D 2.0
  10.                                  By Tom Hudson
  11.  
  12.  
  13.     PD3DCTL.ACC (Public Domain 3D Control Accessory) is a desk accessory
  14.     which allows you to create a motion-control file (with extension .CTL)
  15.     with a text editor and load it into the accessory for execution from
  16.     within CAD-3D 2.0.  The accessory will then control CAD-3D 2.0 as if it
  17.     were being operated by you from the normal user interface, creating a
  18.     CYBERMATE animation sequence.  When changes are made to modes or
  19.     objects, you will not see the CAD-3D control panel change -- it will be
  20.     updated when the accessory terminates.
  21.  
  22.     This admittedly rough accessory was the test bed for the CAD-3D 2.0
  23.     desk accessory communication pipeline during the program's development.
  24.     A full-featured interpreted control language with variables, labels and
  25.     MANY more commands will be available October from THE CATALOG.  In
  26.     addition to fully automated control of all currently available CAD-3D
  27.     2.0 functions, this new product will add many new functions to CAD-3D
  28.     2.0 and make possible the creation of highly complex animation
  29.     sequences.
  30.  
  31.     The .CTL control files are simple text files in which each line is a
  32.     command for CAD-3D 2.0.  The files can be created and edited by any
  33.     ASCII text editor, such as MicroEMACS, 1ST Word (in ASCII mode), or any
  34.     of the commercially available word processing programs.  Alternatively,
  35.     there is a very handy public domain desk accessory called WORD400.ACC
  36.     which can be used from within CAD-3D 2.0.  You can find WORD400.ACC in
  37.     DL4 of SIG*ATARI16.  Whichever editor you use, be sure and set it up so
  38.     that it does not output left margins.
  39.  
  40.     The general format of the command lines are:
  41.  
  42.     CCCC <parameter 1>,<parameter 2>, ... <parameter n>
  43.  
  44.     Where CCCC is a 4-character command string and <parameter> is an
  45.     optional alphanumeric and/or numeric parameter as specified in the
  46.     command summary below.  Note:  The four-character command is not
  47.     case-sensitive; loop and LOOP will work exactly alike.
  48.  
  49.     Comments may be entered with a ';' character as the first character in
  50.     the line, like so:
  51.  
  52.     ;Comment line
  53.  
  54.     Parameters are separated by a single comma.  Do not use spaces in
  55.     parameters.
  56.  
  57.  
  58.                              Miscellaneous notes.
  59.  
  60.     The 3D axis system in CAD-3D may be confusing at first, since it is
  61.     oriented slightly differently than other programs.  The X axis runs
  62.     from left to right in the CAD-3D universe, with the leftmost value in
  63.     the universe -45.00.  The rightmost value is 45.00.  The Y axis runs
  64.     from front to back with the same limits.  The Z axis runs from bottom
  65.     to top with the same limits.  Think of the X/Y plane as being a table
  66.     or other flat surface parallel with the ground, and the Z axis as the
  67.  
  68.                                      - 1 -
  69.  
  70.  
  71.  
  72.  
  73.     altitude.
  74.  
  75.     When referring to the values within the universe (which run from -45.00
  76.     to 45.00 in all three axes), this accessory expects to have them in an
  77.     integer form.  This is a simple operation -- a value of 30.76 is
  78.     entered as 3076.  Just drop the decimal point.  Similarly, a value of
  79.     -19.00 is entered as -1900.  You will find that it helps to think of
  80.     the universe as being a cube 9000 units on a side, ranging from -4500
  81.     to 4500.
  82.  
  83.     Object names are used to refer to the objects within the 3D universe.
  84.     These names are up to eight characters in length, and are
  85.     case-sensitive.  For example, CUBE is not the same object as cube or
  86.     Cube or CUbe.  This can come in handy when referring to several similar
  87.     objects.
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.                                      - 2 -
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.                                    COMMANDS
  142.                                    --------
  143.  
  144.                                BASIC OPERATIONS
  145.                                ----------------
  146.  
  147.     COLR name,color
  148.  
  149.     Recolors the specified object to the specified color.  Example:  COLR
  150.     block,15 recolors "block" to color 15.  Color must range from 1-15.
  151.  
  152.     -----------------------------------------------------------------------
  153.                                      ----
  154.  
  155.     KILL name
  156.  
  157.     Deletes the named object.  KILL froon will delete the object "froon",
  158.     if present.
  159.  
  160.     -----------------------------------------------------------------------
  161.                                      ----
  162.  
  163.     DUPL name,copyname
  164.  
  165.     Makes an exact duplicate of an object, in the same location.  If there
  166.     is an object named THING, the command DUPL THING,THING2 will make a
  167.     copy called THING2.
  168.  
  169.     -----------------------------------------------------------------------
  170.                                      ----
  171.  
  172.                                 VIEW OPERATIONS
  173.                                 ---------------
  174.  
  175.     ZOOM value
  176.  
  177.     Sets the camera zoom.  Range from 0-999.  Example: ZOOM 100
  178.  
  179.     -----------------------------------------------------------------------
  180.                                      ----
  181.  
  182.     PSPC value
  183.  
  184.     Sets the perspective from 0-999.  Example: PSPC 999
  185.  
  186.     -----------------------------------------------------------------------
  187.                                      ----
  188.  
  189.     CAM1 hrot,vrot,bank
  190.  
  191.     Sets the camera to a specific orientation.  All values range from -180
  192.     to 180.  Example: CAM1 0,-40,180
  193.  
  194.     -----------------------------------------------------------------------
  195.                                      ----
  196.  
  197.     VMOD mode
  198.  
  199.  
  200.                                      - 3 -
  201.  
  202.  
  203.  
  204.  
  205.     Set view mode of super view.  Range 0-4 as shown below.  Example:  VMOD
  206.     2 sets solid mode.
  207.  
  208.     modes:
  209.     0: Wire
  210.     1: Hidden
  211.     2: Solid
  212.     3: Outlined
  213.     4: Use camera
  214.  
  215.     -----------------------------------------------------------------------
  216.                                      ----
  217.  
  218.     DFMD mode
  219.  
  220.     Set draft mode (0) or final mode (1).  Example:  DFMD 1 sets final
  221.     (z-buffer).
  222.  
  223.     -----------------------------------------------------------------------
  224.                                      ----
  225.  
  226.     SSEP sep
  227.  
  228.     Sets stereo separation.  "sep" ranges from 1-100%.  Example:  SSEP 100
  229.     sets maximum stereo separation.
  230.  
  231.     -----------------------------------------------------------------------
  232.                                      ----
  233.  
  234.     STEF effect
  235.  
  236.     Sets the stereo effect to in (0), centered (1) or out (2).  Example:
  237.     STEF 0 sets stereo effect to in.  Cannot be altered during an
  238.     animation.
  239.  
  240.     -----------------------------------------------------------------------
  241.                                      ----
  242.  
  243.     STSW switch
  244.  
  245.     Switches stereo off (0) or on (1).  Example:  STSW 1  turns on stereo.
  246.     Cannot be altered during an animation.
  247.  
  248.     -----------------------------------------------------------------------
  249.                                      ----
  250.  
  251.     EDGE mode
  252.  
  253.     Sets to edges only (0) or all lines (1).
  254.  
  255.     -----------------------------------------------------------------------
  256.                                      ----
  257.  
  258.     C1MV hdelta,vdelta,bdelta
  259.  
  260.     Moves the camera "delta" degrees on each axis.  Each delta can range
  261.     from -180 to 180.  Example:  C1MV 3,-6,20  adds 3 to hrot, -6 to vrot,
  262.     and 20 to the bank angle.
  263.  
  264.     -----------------------------------------------------------------------
  265.  
  266.                                      - 4 -
  267.  
  268.  
  269.  
  270.  
  271.                                      ----
  272.  
  273.     CHGZ value
  274.  
  275.     Changes the zoom factor by the specified value.  CHGZ -10 subtracts ten
  276.     from the zoom factor; CHGZ 100 adds 100 to it.
  277.  
  278.     -----------------------------------------------------------------------
  279.                                      ----
  280.  
  281.     CHGP value
  282.  
  283.     Changes the perspective factor by the specified value.  CHGP -147
  284.     subtracts 147 from the perspective factor; CHGP 456 adds 456 to it.
  285.  
  286.     -----------------------------------------------------------------------
  287.                                      ----
  288.  
  289.     SUPR
  290.  
  291.     Generates a super view in the super view buffer.  Does not show the
  292.     image.  This is basically for generating an image that you want to move
  293.     to the background buffer with the VUBG command.
  294.  
  295.     -----------------------------------------------------------------------
  296.                                      ----
  297.  
  298.  
  299.  
  300.                               RECORDER OPERATIONS
  301.                               -------------------
  302.  
  303.     RCON path,filename,mode
  304.  
  305.     Turns on the recording mode.  "path" is the drive/path specification,
  306.     "filename" is the filename to use for the animation, and mode is 0 for
  307.     Sequential, 1 for Cybermate mono, or 2 for Cybermate stereo.  Example:
  308.     RCON c:\,anitest,1  starts a mono Cybermate animation on drive c: in
  309.     the root directory (be sure to include the '\' character) called
  310.     "anitest".  If you're going to a folder, use RCON b:\folder\,froon,1.
  311.  
  312.     -----------------------------------------------------------------------
  313.                                      ----
  314.  
  315.     RCRD
  316.  
  317.     Records a frame of animation.  RCON must have been successfully
  318.     executed.
  319.  
  320.     -----------------------------------------------------------------------
  321.                                      ----
  322.  
  323.     RCOF
  324.  
  325.     Turns off recording, closing the animation file.
  326.  
  327.     -----------------------------------------------------------------------
  328.                                      ----
  329.  
  330.                                GROUP OPERATIONS
  331.  
  332.                                      - 5 -
  333.  
  334.  
  335.  
  336.  
  337.                                ----------------
  338.  
  339.     SGRP group
  340.  
  341.     Selects group 0-3, corresponding to A-D.  Example: SGRP 2 selects group
  342.     C.
  343.  
  344.     -----------------------------------------------------------------------
  345.                                      ----
  346.  
  347.     HOME
  348.  
  349.     Homes the current group.
  350.  
  351.     -----------------------------------------------------------------------
  352.                                      ----
  353.  
  354.     SCAL percent
  355.  
  356.     Scales the current group from 50-200 percent.  Example: SCAL 157
  357.     scales the group to 157%.
  358.  
  359.     -----------------------------------------------------------------------
  360.                                      ----
  361.  
  362.     RCTR type
  363.  
  364.     Sets the rotational center to universe (0), group (1) or arbitrary (2).
  365.     Example: RCTR 0  sets universe mode.
  366.  
  367.     -----------------------------------------------------------------------
  368.                                      ----
  369.  
  370.     ARBC x,y,z
  371.  
  372.     Sets the arbitrary rotation center to the X,Y,Z coords.  Values range
  373.     from -4500 to 4500, the integer equivalents of -45.00 to 45.00.  0,0,0
  374.     is the universe center.  Example:  ARBC 1000,2000,-2345 sets the
  375.     arbitrary center to X=10.00, Y=20.00 Z=-23.45.
  376.  
  377.     -----------------------------------------------------------------------
  378.                                      ----
  379.  
  380.     GROT deltaz,deltax,deltay
  381.  
  382.     Rotates the current group around the rotational center by the specified
  383.     degree increment on the specified axis.  Degree values range from -180
  384.     to 180.  For best results, use this command one axis at a time.
  385.     Example: GROT 45,0,0  rotates the group 45 degrees around the Z axis.
  386.     Remember -- CAD-3D's axis system is aligned such that the X axis runs
  387.     from left to right, the Y axis runs from front to back and the Z axis
  388.     runs from bottom to top.  Therefore, the GROT command can be thought of
  389.     as:  GROT toprot,rightrot,frontrot because the rotation is seen from
  390.     the window indicated.  The GROT 45,0,0 command will rotate the group 45
  391.     degrees clockwise as seen in the top window.  GROT -45,0,0 will return
  392.     it to its previous orientation.
  393.  
  394.     -----------------------------------------------------------------------
  395.                                      ----
  396.  
  397.  
  398.                                      - 6 -
  399.  
  400.  
  401.  
  402.  
  403.     AXSC xscale,yscale,zscale
  404.  
  405.     Scales each axis independently.  "xscale" is the X axis scale
  406.     percentage, "yscale" is the Y axis scale percentage, and "zscale" is
  407.     the Z axis scale percentage.  All percentage values run from 50 to 200
  408.     -- a value of 100 leaves that axis unchanged.
  409.  
  410.     -----------------------------------------------------------------------
  411.                                      ----
  412.  
  413.     XLAT deltax,deltay,deltaz
  414.  
  415.     Translate the group the specified distance, in integer floating-point
  416.     equivalents, up to 10.00 units.  To translate a group of objects 5
  417.     units in the X axis, 5.67 units in the Y axis and -8.89 units in the Z
  418.     axis, use the command:  XLAT 500,567,-889.
  419.  
  420.     -----------------------------------------------------------------------
  421.                                      ----
  422.  
  423.     SLCT name,switch
  424.  
  425.     Select/deselect an object in the current group.  "name" is the name of
  426.     the object, switch is 0 (deselect) or 1(select).  SLCT cube,1  will
  427.     select the object "cube".
  428.  
  429.     -----------------------------------------------------------------------
  430.                                      ----
  431.  
  432.     CGRP
  433.  
  434.     Clears the current object group (deselects all objects).
  435.  
  436.     -----------------------------------------------------------------------
  437.                                      ----
  438.  
  439.     GALL
  440.  
  441.     Selects all objects in the current group.
  442.  
  443.     -----------------------------------------------------------------------
  444.                                      ----
  445.  
  446.                                BUFFER OPERATIONS
  447.                                -----------------
  448.  
  449.     BGND switch
  450.  
  451.     Turns the background on (1) or off (0).  Background buffer must have
  452.     been reserved at start-up time to use.  Example: BGND 0  turns off the
  453.     background.
  454.  
  455.     -----------------------------------------------------------------------
  456.                                      ----
  457.  
  458.     CLBG
  459.  
  460.     Clears the background.
  461.  
  462.     -----------------------------------------------------------------------
  463.  
  464.                                      - 7 -
  465.  
  466.  
  467.  
  468.  
  469.                                      ----
  470.  
  471.     VUBG
  472.  
  473.     Moves the current view to the background buffer
  474.  
  475.     -----------------------------------------------------------------------
  476.                                      ----
  477.  
  478.                                  LOOP COMMANDS
  479.                                  -------------
  480.  
  481.     LOOP count
  482.  
  483.     Starts a loop that will execute "count" times.  Loop starts with LOOP
  484.     command, ends with **** command (see below).
  485.  
  486.     Example:
  487.  
  488.     LOOP 40
  489.     C1MV 9,0,0
  490.     RCRD
  491.     ****
  492.  
  493.     Is a loop that will move the camera 9 degrees horizontally 40 times,
  494.     each time recording a frame.  This will record a complete circle around
  495.     the scene.  You can have nested loops, up to 10 levels.
  496.  
  497.     -----------------------------------------------------------------------
  498.                                      ----
  499.  
  500.     ****
  501.  
  502.     This command specifies the end of a loop.  Be sure to have one of these
  503.     for each loop, or your batch file will probably fail with an error
  504.     message.
  505.  
  506.     -----------------------------------------------------------------------
  507.                                      ----
  508.  
  509.  
  510.     Have fun with this accessory, and watch for new animation control files
  511.     on CompuServe's Antic On-Line in the CYBER CONNECTION section.  If you
  512.     come up with an interesting animation, why not archive the .3D2 file,
  513.     control file and background image, if any, and upload them to SIG*Atari
  514.     and your local BBS's for others to enjoy?
  515.  
  516.     -Tom Hudson/The Catalog
  517.  
  518.  
  519.     NOTE:  PD3DCTL.ACC may only be distributed in the public domain for
  520.     free.  It may not be resold.
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.                                      - 8 -
  531.  
  532.  
  533.